****************************************************************************************
************************** Your Own Storyline (YOS) - Plugin ***************************
****************************************************************************************
This ASI plugin allows you to override the non-moddable vanilla YSC scripts with your own storyline script,
and thus allows you to make Mission or Map Total Conversion mods for GTA V.

************************
Features
************************
* Automatically cleans up the gameworld, requiring no user intervention, or completion of the Prologue prior to mod activation
* Built-in support for saving and reloading mission script state and gameworld properties
* Simple, fast scripting engine

************************
Installation
************************
Copy everything from within the 'plugin' directory into the GTA V main game directory (where the EXE, DLL, and other ASI files are located).
For the mod to function, you'll need the ASI Loader and ScriptHookV to be installed!

************************
Using the mod
************************
This mod is designed to run binary YOS scripts (main.yos). If you already have a 'main.yos' file, then copy it into the 'yos_data/mission_script' directory.
If you don't have access to an already compiled script, you'll need to use the v2 compiler (can be downloaded from this mod's GTA5-Mods page),
or the v1 compiler (can be downloaded from my personal website, link available at this mod's GTA5-Mods page), and compile your script.
If you don't even have a script text file, you'll need to write your own. For this, you can download some example scripts (from this mod's GTA5-Mods page).

When you start your game, the mod automatically perfroms all necessary cleanup tasks, and shows its menu, from where you can start a new YOS game or load YOS saved game.
If you would like to start a new YOS game or load a YOS saved game during gameplay, press the Interaction Menu button ('M' by default), to access the YOS 'Load Game' menu again.
Please note, that you cannot save your YOS gameplay manually. In order to be able to save your YOS gameplay, you'll need to write a script,
which then activates the YOS 'Save Game' menu, when needed. You can save your game there.
Saved games can be found in the 'yos_data/saved_games' directory. They're strongly tied to the script, so if you modify or replace the mission script, saved games will break!

The mod works fine without a mission script, but in that case, the 'Load Game' menu is not accessible, no YOS savegames can be loaded, no new YOS game can be started, only the cleanup tasks are performed!

************************
Compatibility
************************
The mod forcefully kills all GTA V vanilla scripts, and fully cleans up the gameworld upon initialization, loading a YOS savegame, or starting a new YOS game.
As a result, virtually all scripted features will be disabled (eg. mobile phone, shops, garages).
Most mission packs, game feature exapsnsion mods, and improvements are thus **NOT** compatible with YOS, unless they use no such scripted features.
Some small mission mods may be compatible, if extra care is taken by the player.

************************
Editing data files
************************
The data files inside the 'yos_data/data' directory allows updating certain gameplay features and mod properties, without requiring recompilation of the ASI plugin.
These files are required for the correct operation of the mod.
You should not touch any of these files, unless you **REALLY** know what you're doing.
